/***************************************************************************
 * Copyright 2012-2013 TXT e-solutions SpA
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work was performed within the IoT_at_Work Project
 * and partially funded by the European Commission's
 * 7th Framework Programme under the contract ICT-257367.
 *
 * Authors:
 *      Salvatore Piccione (TXT e-solutions SpA)
 *
 * Contributors:
 *        Domenico Rotondi (TXT e-solutions SpA)
 **************************************************************************/
package it.txt.ens.client.core;

import it.txt.ens.core.ENSAuthzServiceConnectionParameters;

import java.util.Date;

/**
 * This interface defines the set of parameters required to connect to an Event Notification Service (ENS)
 * Broker.
 * 
 * @author Salvatore Piccione (TXT e-solutions SpA - salvatore.piccione AT txtgroup.com)
 * @author Domenico Rotondi (TXT e-solutions SpA - domenico.rotondi AT txtgroup.com)
 *
 */
public interface ENSBrokerConnectionParameters extends ENSAuthzServiceConnectionParameters{
    
    /**
     * Returns the unique identifier of the communication session.
     * 
     * @return the identifier of the communication session.
     */
    public String getSessionToken ();
    
    /**
     * Returns the instant when the session expires.
     * 
     * @return the session expiration instant (milliseconds precision) or <code>null</code> if the session expires only when the client disconnects
     */
    public Date getSessionExpiration ();
    
    /**
     * The format of configuration parameters values indicating date time. 
     */
    public static final String DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss.SSS Z";
    
}
